/*
** Copyright (c) 2008 Mobile GCalendarManager
**
** Permission is hereby granted, free of charge, to any person
** obtaining a copy of this software and associated documentation
** files (the "Software"), to deal in the Software without
** restriction, including without limitation the rights to use,
** copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the
** Software is furnished to do so, subject to the following
** conditions:
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
** NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
** HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
** WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
** FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
** OTHER DEALINGS IN THE SOFTWARE.
*/

/**
 *
 */
package au.edu.mq.comp.itec800.mgc.ui.cli;

import au.edu.mq.comp.itec800.mgc.ui.UserInterface;

/**
 * Implements a simple and reusable console-based interface,
 * which uses the java.io.Console in a console-friendly
 * environment, or otherwise implements a basic text-based
 * interface with limited functionality.
 *
 * @see UserInterface
 * @see java.io.Console
 *
 * @author Laurent Malvert [laurent.malvert@students.mq.edu.au]
 */
public abstract class Console implements UserInterface
{
  private ConsoleIO     io      = ConsoleIO.Console;
  private ConsoleStatus status  = ConsoleStatus.STOPPED;


  public Console()
  {
    io = (System.console() != null) ? ConsoleIO.Console : ConsoleIO.Streams;
  }

  public abstract void    process(final String cmd);

  public String           prompt(final String format, final Object ... args)
  {
    return (String.format(format, args));
  }

  /* (non-Javadoc)
   * @see java.lang.Runnable#run()
   */
  public void             run()
  {
    status = ConsoleStatus.RUNNING;
    while (status == ConsoleStatus.RUNNING)
    {
      process(io.input(prompt("")));
    }
  }

  public void             stop()
  {
    status = ConsoleStatus.STOPPED;
  }

  public ConsoleIO        getIO()
  {
    return (io);
  }
}
